docs: fix descriptions - #14363
Merged
Merged
Conversation
The `lib/main.js` JSDoc summary was missing the word "to"
("WebAssembly module compute ..."), diverging from the sibling
convention "WebAssembly module to <verb> ..." present in 32 of 33
namespace packages (97% conformance) and from the package's own
`lib/index.js` summary. Insert "to" to restore the pattern. The
change is a grammar fix to a documentation comment and does not alter
the described operation or any public behavior.
The README referred to "double-precision floating point vectors" (unhyphenated) in all five occurrences, diverging from the hyphenated compound modifier "floating-point" used in 12 of 14 sibling READMEs that mention the term and in the package's own `lib/main.js` JSDoc. Hyphenate all occurrences to match the namespace convention. The change is documentation-only and does not affect public behavior. The same wording in `docs/repl.txt` and `docs/types/index.d.ts` is left untouched, as those files are out of scope for this change.
The README referred to "single-precision floating point vectors" (unhyphenated) in all five occurrences, diverging from the hyphenated compound modifier "floating-point" used in 12 of 14 sibling READMEs that mention the term and in the package's own `lib/main.js` JSDoc. Hyphenate all occurrences to match the namespace convention. The change is documentation-only and does not affect public behavior. The same wording in `docs/repl.txt` and `docs/types/index.d.ts` is left untouched, as those files are out of scope for this change.
stdlib-bot
added
the
BLAS
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
August 18, 2026 11:03
kgryte
approved these changes
Aug 18, 2026
kgryte
changed the title
blas/base/wasm packages
kgryte
added
the
Documentation
stdlib-bot
added
Needs Review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request corrects three documentation-drift findings in the
blas/base/wasmnamespace, bringing three outlier packages back in line with the documentation conventions used by the rest of the namespace. All changes are documentation-only; no source behavior, public signatures, or test expectations are affected.Namespace summary
@stdlib/blas/base/wasm.package.jsonkey set /scripts/stdlibconfig,manifest.jsonkey set, README section list and ordering, andtest//benchmark//examples/file naming were byte-uniform across all 33 packages.main.jsJSDoc shape (all packages documentmain,ndarray, andModulewith examples), return kind (all export aRoutine), and error construction (100% useformat— a single, identicalTypeErrorguard on the WebAssembly memory instance).requiredependency sets, which legitimately vary per BLAS routine (single vs. double precision, real vs. complex, presence of a scalar argument, number of stride/offset arguments). These are correct-by-design differences, not drift.Only three deviations from the namespace majority survived validation, all in package documentation:
blas/base/wasm/scasumThe
lib/main.jsJSDoc summary read "WebAssembly module compute the sum of the absolute values...", dropping the word "to". 32 of 33 packages (97%) use the form "WebAssembly module to ...", andscasum's ownlib/index.jssummary already reads "WebAssembly routine to compute...". Inserted the missing "to" to restore the sibling pattern; the described operation is unchanged.blas/base/wasm/dswapThe README described the operation on "double-precision floating point vectors" (unhyphenated) in all five occurrences. The hyphenated compound modifier "floating-point" is used in 12 of the 14 sibling READMEs that mention the term, and in
dswap's ownlib/main.jsJSDoc. Hyphenated all five occurrences to match;dswapandsswapwere the only two READMEs in the namespace using the unhyphenated form.blas/base/wasm/sswapIdentical to
dswap: the README used "single-precision floating point vectors" (unhyphenated) in all five occurrences, contradicting the namespace majority andsswap's ownlib/main.jsJSDoc. Hyphenated all five occurrences to "floating-point".Related Issues
None.
Questions
The same unhyphenated "floating point" wording also appears in
docs/repl.txtanddocs/types/index.d.tsfordswapandsswap. Those files were intentionally left untouched here (declaration files are part of the public API and REPL fixtures are treated as generator-adjacent); a maintainer may prefer to normalize them in a follow-up.Other
Validation. Structural features were extracted deterministically across all 33 packages. Semantic features were cross-checked both deterministically (error-construction, JSDoc tag structure, require sets, copyright headers) and via parallel review across three lenses (documentation, source/validation, metadata). Each surviving outlier was then independently reviewed by three validators — semantic review (intentional vs. unintentional drift), cross-reference (whether any test or example relies on the wording, and whether a documented API contract would break), and structural review (whether the majority form is what should actually be applied). All three validators returned
confirmed-driftfor all three outliers.Deliberately excluded: per-routine signature and dependency differences (correct-by-design, no clear majority); the
docs/repl.txtanddocs/types/index.d.tsoccurrences of the same hyphenation (out of scope per the above); and copyright-year differences across packages (these reflect authoring date, not drift). The structural analysis found no missing files or fields to add — the namespace is otherwise uniform.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was produced by Claude Code running an automated cross-package documentation-drift detection routine over the
blas/base/wasmnamespace. Claude performed the structural and semantic feature extraction, computed per-feature majority patterns, identified and validated the outliers, applied the documentation fixes, and drafted this description. All changes are documentation-only and were reviewed for behavior preservation.Generated by Claude Code